Skip to content

Add .github/copilot-instructions.md for Copilot coding agent onboarding#15

Merged
dmartinol merged 3 commits into
mainfrom
copilot/add-copilot-instructions-file
Feb 25, 2026
Merged

Add .github/copilot-instructions.md for Copilot coding agent onboarding#15
dmartinol merged 3 commits into
mainfrom
copilot/add-copilot-instructions-file

Conversation

Copilot AI commented Feb 25, 2026

Copy link
Copy Markdown
Contributor

Adds the standard .github/copilot-instructions.md file to give Copilot coding agent immediate, actionable context about this repository without requiring it to explore from scratch.

Contents

  • Repo structure — top-level layout and per-pack directory anatomy
  • Build/validate/test commandsmake validate (CI gate), make generate, make test, make serve; highlights that make validate must pass before pushing
  • Key file formats — YAML frontmatter requirements for SKILL.md and agent .md files; .mcp.json credential-reference pattern
  • Design principles (condensed from CLAUDE.md) — skill-over-tools precedence, document consultation as an action (not a claim), precise MCP parameters, human-in-the-loop for destructive ops, never print credential values
  • How to add a new pack or skill — including the required PACK_DIRS registration in scripts/validate_structure.py
  • Common errors table — missing frontmatter, JSON syntax, unknown pack, missing uv, gitleaks blocks

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…boarding

Co-authored-by: dmartinol <86618610+dmartinol@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot instructions for efficient onboarding Add .github/copilot-instructions.md for Copilot coding agent onboarding Feb 25, 2026
@dmartinol dmartinol marked this pull request as ready for review February 25, 2026 22:18
@dmartinol dmartinol requested a review from Copilot February 25, 2026 22:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a .github/copilot-instructions.md onboarding document to give Copilot coding agent immediate repository-specific context (structure, commands, file format requirements, and key design/security principles) without requiring a full repo scan.

Changes:

  • Introduces Copilot-specific repository overview and pack anatomy guidance.
  • Documents standard local/CI commands (make install/validate/generate/test/serve) and validation expectations.
  • Captures key formatting/security rules (YAML frontmatter requirements, .mcp.json env-var credential pattern, gitleaks notes) and pack/skill creation steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/copilot-instructions.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@dmartinol dmartinol merged commit 45d4a85 into main Feb 25, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants